[utils] Add opt-in DataAttributesOverrides augmentation for slot props#48554
[utils] Add opt-in DataAttributesOverrides augmentation for slot props#48554LukasTy wants to merge 5 commits into
DataAttributesOverrides augmentation for slot props#48554Conversation
Today, passing `data-testid` (or any `data-*` attribute) through `slotProps`
on a MUI component is a TypeScript error even though the attribute is
forwarded to the DOM at runtime. This adds a single, opt-in switch that
lets consumers declare exactly which `data-*` keys they want typed, at
whichever level of strictness they choose.
- `DataAttributesOverrides`: module-augmentable empty interface in
`@mui/utils/types`. The single sanctioned switch.
- `DataAttributes = DataAttributesOverrides`: dormant by default;
populated only when a consumer augments.
- `WithDataAttributes<T> = T | (T & DataAttributes)`: union form so the
original `T` stays assignable as-is (preserves backwards compatibility
with `x as CustomProps` style casts on slot values), while augmented
keys flow through the widened branch when consumers opt in.
- `SlotComponentProps` and `SlotComponentPropsWithSlotState` now wrap
their object and callback branches with `WithDataAttributes`. With an
empty default the wrapping is a no-op until a consumer augments — once
they do, every Material component that reaches slot props through these
helpers (or through `SlotProps` in `@mui/material`) picks up the new
keys automatically.
Consumers opt in with a single `declare module '@mui/utils/types' { ... }`
block. Examples are documented in the new `DataAttributes.ts` file and
exercised by a module-augmentation test using Backdrop's root slot.
This is the canonical place for the helper because every MUI slot prop
type ultimately flows through `@mui/utils/types`; downstream packages
(`@mui/x-*` and friends) get the augmentation transitively without
having to mirror the helper themselves.
Deploy previewhttps://deploy-preview-48554--material-ui.netlify.app/ Bundle size
Check out the code infra dashboard for more information about this PR. |
I would go with this option if we do decide to do something about it, as it reflects the primitives elements. Can you link some issues related to the problem? What are people typically complaining about. |
Umbrella issues
More specific reports (same root cause)
What people are actually complaining about
On the "anything goes" formAgreed, and the opt-in design already supports it as the headline example: That single augmentation lights up every slot of every Material (and downstream X) component at once, which directly answers the "I just want data-* everywhere, like the primitive elements" use case from #33175 and #22126. The strongly-typed form (one named key) stays available for teams that want a closed allow-list, but I am happy to make the index-signature form the primary documented example since it matches what most of these reports are asking for. One drawback of this approach is no IntelliSense. With specific typing, users would get autocompletion for defined fields. |
- DataAttributes.ts: convert the augmentation examples to JSDoc `@example`
tags so they surface in IDE quick-info. Lead with the loose
index-signature form, which mirrors the primitive elements and matches
what most reports ask for.
- dataAttributesOverrides.spec.tsx: switch the primary spec to the loose
`[k: \`data-${string}\`]` form and exercise both the object and callback
branches of the slot-prop union.
- dataAttributesOverridesAllowList.spec.tsx (new): cover the strict,
closed-allow-list form, with a `@ts-expect-error` proving an undeclared
`data-*` key is still rejected.
- DataAttributes.ts: note in the JSDoc that the loose index-signature form accepts any `data-*` key but gives no autocomplete, while the strongly-typed form restricts to declared keys in exchange for IntelliSense and typo-checking. - Cross-reference the loose and narrow module-augmentation specs so the pair is discoverable from either file, and spell out why they must live in separate compilation units (augmentation is global, so the loose index signature would otherwise swallow the narrow allow-list).
Created based on mui/mui-x#22128 exploration.
Closes #33175.
Summary
Adds a single opt-in switch —
DataAttributesOverrides— that lets consumers declare typed support fordata-*attributes on every MUI slot prop. Augmenting the interface is the one sanctioned way to flip the level of strictness; nothing is widened by default.Today, code like
is a TypeScript error even though the attribute is forwarded to the DOM at runtime. After this PR, consumers can opt in with a one-time augmentation:
Or, for the loose / "anything goes" form:
After augmentation, every Material component that wires slot props through
SlotComponentProps/SlotComponentPropsWithSlotState(or throughSlotPropsin@mui/material) picks up the augmented keys automatically.Changes
@mui/utils/typesDataAttributes.ts:DataAttributesOverrides— empty, module-augmentable interface. The single switch consumers flip.DataAttributes = DataAttributesOverrides— dormant by default; activates when augmented.WithDataAttributes<T> = T | (T & DataAttributes)— union form so the originalTstays assignable as-is (preserves backwards compatibility withx as CustomPropsstyle casts on slot values), while augmented keys flow through the widened branch when consumers opt in.index.tsre-exports the new symbols, and wraps bothSlotComponentPropsandSlotComponentPropsWithSlotState(object branch and callback branch) withWithDataAttributes.Module-augmentation test
packages/mui-material/test/typescript/moduleAugmentation/dataAttributesOverrides.{spec.tsx,tsconfig.json}augments@mui/utils/typesand uses Backdrop'srootslot to verify the augmentation flows throughSlotProps→SlotComponentProps→WithDataAttributes.Notes for reviewers
Why a union, not an intersection
Only the widened variant carries
DataAttributes. This preserves backwards compatibility:{ id: 'foo' } as CustomLabelPropsassigns to the narrow variant, soCustomLabelPropsdoes not need to declare adata-${string}index signature.{ 'data-testid': 'x' }(after augmentation) assigns to the widened variant.WithDataAttributes, so consumers returningsomeObj as CustomPropsfrom a slot callback stay assignable.Why opt-in (no default widening)
Slot prop types should not silently accept arbitrary
data-*keys — that hides typos, makes the surface less discoverable in hover/autocomplete, and disagrees with the principle that React's typed surface is what consumers see.The augmentation hook is a single, well-known module path (
@mui/utils/types) that consumers can shape to whichever level they want: strict (one named key), loose (fulldata-*template-literal index signature), or anywhere in between.Why
@mui/utils/typesis the right homeEvery MUI slot prop type ultimately flows through
SlotComponentProps/SlotComponentPropsWithSlotStatein@mui/utils/types. Putting the augmentation hook here means:@mui/x-data-grid,@mui/x-date-pickers,@mui/x-charts, ...) inherit the augmentation transitively — they don't need to mirror the helper themselves.Test plan
pnpm --filter "@mui/utils" run typescriptpasses.pnpm --filter "@mui/material" run typescriptpasses.pnpm typescript:module-augmentation— all 21+ existing tests pass, plus the new one.pnpm prettier --checkandpnpm eslintclean on the changed files.DataAttributesOverridesaugmentation above,<Backdrop slotProps={{ root: { 'data-testid': 'foo' } }} />type-checks and forwards to the DOM as expected. Without the augmentation, the same code is a TS error (matches today).